<html>
<head>
  <link rel="stylesheet" type="text/css" href="main.css">
</head>
<body>
  <div class="main">
    <h1>Namespace: joker.string</h1>
    <span class="var-added">v1.0</span>
    <h2>Contents</h2>
    <ul>
      <li>
        <a href="#_summary">Summary</a>
      </li>
      <li>
        <a href="#_index">Index</a>
      </li>
      <li>
        <a href="#_constants">Constants</a>
      </li>
      <li>
        <a href="#_variables">Variables</a>
      </li>
      <li>
        <a href="#_functions">Functions, Macros, and Special Forms</a>
      </li>
    </ul>
    <h2 id="_summary">Summary</h2>
    <p class="var-docstr">Implements simple functions to manipulate strings.</p>
    <h2 id="_index">Index</h2>
    <ul class="index">
      <li>
  <a href="#blank?">blank?</a>
</li>
<li>
  <a href="#capitalize">capitalize</a>
</li>
<li>
  <a href="#ends-with?">ends-with?</a>
</li>
<li>
  <a href="#escape">escape</a>
</li>
<li>
  <a href="#includes?">includes?</a>
</li>
<li>
  <a href="#index-of">index-of</a>
</li>
<li>
  <a href="#join">join</a>
</li>
<li>
  <a href="#last-index-of">last-index-of</a>
</li>
<li>
  <a href="#lower-case">lower-case</a>
</li>
<li>
  <a href="#pad-left">pad-left</a>
</li>
<li>
  <a href="#pad-right">pad-right</a>
</li>
<li>
  <a href="#re-quote">re-quote</a>
</li>
<li>
  <a href="#replace">replace</a>
</li>
<li>
  <a href="#replace-first">replace-first</a>
</li>
<li>
  <a href="#reverse">reverse</a>
</li>
<li>
  <a href="#split">split</a>
</li>
<li>
  <a href="#split-lines">split-lines</a>
</li>
<li>
  <a href="#starts-with?">starts-with?</a>
</li>
<li>
  <a href="#trim">trim</a>
</li>
<li>
  <a href="#trim-left">trim-left</a>
</li>
<li>
  <a href="#trim-newline">trim-newline</a>
</li>
<li>
  <a href="#trim-right">trim-right</a>
</li>
<li>
  <a href="#triml">triml</a>
</li>
<li>
  <a href="#trimr">trimr</a>
</li>
<li>
  <a href="#upper-case">upper-case</a>
</li>

    </ul>
    <h2 id="_constants">Constants</h2>
    Constants are variables with <tt>:const true</tt> in their metadata. Joker currently does not recognize them as special; as such, it allows redefining them or their values.
    <ul>
      (None.)
    </ul>
    <h2 id="_variables">Variables</h2>
    <ul>
      (None.)
    </ul>
    <h2 id="_functions">Functions, Macros, and Special Forms</h2>
    <ul>
      <li>
  <h3 class="Function" id="blank?">blank?</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(blank? s)</code></div>
</pre>
  <p class="var-docstr">True if s is nil, empty, or contains only whitespace.</p>
  
  
</li>
<li>
  <h3 class="Function" id="capitalize">capitalize</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(capitalize s)</code></div>
</pre>
  <p class="var-docstr">Converts first character of the string to upper-case, all other<br>
  characters to lower-case.</p>
  
  
</li>
<li>
  <h3 class="Function" id="ends-with?">ends-with?</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(ends-with? s substr)</code></div>
</pre>
  <p class="var-docstr">True if s ends with substr.</p>
  
  
</li>
<li>
  <h3 class="Function" id="escape">escape</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(escape s cmap)</code></div>
</pre>
  <p class="var-docstr">Return a new string, using cmap to escape each character ch<br>
  from s as follows:<br>
<br>
  If (cmap ch) is nil, append ch to the new string.<br>
  If (cmap ch) is non-nil, append (str (cmap ch)) instead.</p>
  
  
</li>
<li>
  <h3 class="Function" id="includes?">includes?</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(includes? s substr)</code></div>
</pre>
  <p class="var-docstr">True if s includes substr.</p>
  
  
</li>
<li>
  <h3 class="Function" id="index-of">index-of</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(index-of s value)</code></div>
<div><code>(index-of s value from)</code></div>
</pre>
  <p class="var-docstr">Return index of value (string or char) in s, optionally searching<br>
  forward from from or nil if not found.</p>
  
  
</li>
<li>
  <h3 class="Function" id="join">join</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(join coll)</code></div>
<div><code>(join separator coll)</code></div>
</pre>
  <p class="var-docstr">Returns a string of all elements in coll, as returned by (seq coll), separated by an optional separator.</p>
  
  
</li>
<li>
  <h3 class="Function" id="last-index-of">last-index-of</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(last-index-of s value)</code></div>
<div><code>(last-index-of s value from)</code></div>
</pre>
  <p class="var-docstr">Return last index of value (string or char) in s, optionally<br>
  searching backward from from or nil if not found.</p>
  
  
</li>
<li>
  <h3 class="Function" id="lower-case">lower-case</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(lower-case s)</code></div>
</pre>
  <p class="var-docstr">Converts string to all lower-case.</p>
  
  
</li>
<li>
  <h3 class="Function" id="pad-left">pad-left</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(pad-left s pad n)</code></div>
</pre>
  <p class="var-docstr">Returns s padded with pad at the beginning to length n.</p>
  
  
</li>
<li>
  <h3 class="Function" id="pad-right">pad-right</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(pad-right s pad n)</code></div>
</pre>
  <p class="var-docstr">Returns s padded with pad at the end to length n.</p>
  
  
</li>
<li>
  <h3 class="Function" id="re-quote">re-quote</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(re-quote s)</code></div>
</pre>
  <p class="var-docstr">Returns an instance of Regex that matches the string exactly</p>
  
  
</li>
<li>
  <h3 class="Function" id="replace">replace</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(replace s match repl)</code></div>
</pre>
  <p class="var-docstr">Replaces all instances of match (String or Regex) with string repl in string s.<br>
<br>
  If match is Regex, $1, $2, etc. in the replacement string repl are<br>
  substituted with the string that matched the corresponding<br>
  parenthesized group in the pattern.<br>
  </p>
  
  
</li>
<li>
  <h3 class="Function" id="replace-first">replace-first</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(replace-first s match repl)</code></div>
</pre>
  <p class="var-docstr">Replaces the first instance of match (String or Regex) with string repl in string s.<br>
<br>
  If match is Regex, $1, $2, etc. in the replacement string repl are<br>
  substituted with the string that matched the corresponding<br>
  parenthesized group in the pattern.<br>
  </p>
  
  
</li>
<li>
  <h3 class="Function" id="reverse">reverse</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(reverse s)</code></div>
</pre>
  <p class="var-docstr">Returns s with its characters reversed.</p>
  
  
</li>
<li>
  <h3 class="Function" id="split">split</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(split s sep)</code></div>
<div><code>(split s sep n)</code></div>
</pre>
  <p class="var-docstr">Splits string on a string or regular expression. Returns vector of the splits.<br>
<br>
  No more than n elements will be returned in the vector; the last element will<br>
  be the unsplit remainder. If n is &lt;= 0, no limit is in effect (all substrings<br>
  are returned in the vector).</p>
  
  
</li>
<li>
  <h3 class="Function" id="split-lines">split-lines</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(split-lines s)</code></div>
</pre>
  <p class="var-docstr">Splits string on \n or \r\n. Returns vector of the splits.</p>
  
  
</li>
<li>
  <h3 class="Function" id="starts-with?">starts-with?</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(starts-with? s substr)</code></div>
</pre>
  <p class="var-docstr">True if s starts with substr.</p>
  
  
</li>
<li>
  <h3 class="Function" id="trim">trim</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(trim s)</code></div>
</pre>
  <p class="var-docstr">Removes whitespace from both ends of string.</p>
  
  
</li>
<li>
  <h3 class="Function" id="trim-left">trim-left</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(trim-left s)</code></div>
</pre>
  <p class="var-docstr">Removes whitespace from the left side of string.</p>
  
  
</li>
<li>
  <h3 class="Function" id="trim-newline">trim-newline</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(trim-newline s)</code></div>
</pre>
  <p class="var-docstr">Removes all trailing newline \n or return \r characters from string.</p>
  
  
</li>
<li>
  <h3 class="Function" id="trim-right">trim-right</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(trim-right s)</code></div>
</pre>
  <p class="var-docstr">Removes whitespace from the right side of string.</p>
  
  
</li>
<li>
  <h3 class="Function" id="triml">triml</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(triml s)</code></div>
</pre>
  <p class="var-docstr">Removes whitespace from the left side of string.</p>
  
  
</li>
<li>
  <h3 class="Function" id="trimr">trimr</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(trimr s)</code></div>
</pre>
  <p class="var-docstr">Removes whitespace from the right side of string.</p>
  
  
</li>
<li>
  <h3 class="Function" id="upper-case">upper-case</h3>
  <span class="var-kind Function">Function</span>
  <span class="var-added">v1.0</span>
  <pre class="var-usage"><div><code>(upper-case s)</code></div>
</pre>
  <p class="var-docstr">Converts string to all upper-case.</p>
  
  
</li>

    </ul>
  </div>
</body>
<script src="main.js"></script>
</html>
